/*
-------------------------------------------------------------------------
 CxxTest: A lightweight C++ unit testing library.
 Copyright (c) 2008 Sandia Corporation.
 This software is distributed under the LGPL License v3
 For more information, see the COPYING file in the top CxxTest directory.
 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
 the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------
*/

#ifndef __cxxtest__ErrorFormatter_h__
#define __cxxtest__ErrorFormatter_h__

//
// The ErrorFormatter is a TestListener that
// prints reports of the errors to an output
// stream.  Since we cannot rely on the standard
// iostreams, this header defines a base class
// analogout to std::ostream.
//

#include <cxxtest/TestRunner.h>
#include <cxxtest/TestListener.h>
#include <cxxtest/TestTracker.h>
#include <cxxtest/ValueTraits.h>
#include <cstdio>

namespace CxxTest
{
class OutputStream
{
public:
    virtual ~OutputStream() {}
    virtual void flush() {};
    virtual OutputStream &operator<<(unsigned /*number*/) { return *this; }
    virtual OutputStream &operator<<(const char * /*string*/) { return *this; }

    typedef void (*Manipulator)(OutputStream &);

    virtual OutputStream &operator<<(Manipulator m) { m(*this); return *this; }
    static void endl(OutputStream &o) { (o << "\n").flush(); }
};

class ErrorFormatter : public TestListener
{
public:
    ErrorFormatter(OutputStream *o, const char *preLine = ":", const char *postLine = "",
                   const char *errorString = "Error",
                   const char *warningString = "Warning") :
        _dotting(true),
        _reported(false),
        _o(o),
        _preLine(preLine),
        _postLine(postLine),
        _errorString(errorString),
        _warningString(warningString)
    {
    }

    int run()
    {
        TestRunner::runAllTests(*this);
        return tracker().failedTests();
    }

    void enterWorld(const WorldDescription& desc)
    {
        (*_o) << "Running " << desc.worldName() << " tests (" << totalTests << ")";
        _o->flush();
        _dotting = true;
        _reported = false;
    }

    static void totalTests(OutputStream &o)
    {
        char s[WorldDescription::MAX_STRLEN_TOTAL_TESTS];
        const WorldDescription &wd = tracker().world();
        o << wd.strTotalTests(s) << (wd.numTotalTests() == 1 ? " test" : " tests");
    }

    void enterSuite(const SuiteDescription &)
    {
        _reported = false;
    }

    void enterTest(const TestDescription &)
    {
        _reported = false;
    }

    void leaveTest(const TestDescription &)
    {
        if (tracker().testSkipped())
        {
            (*_o) << "s";
            _o->flush();
            fflush(stdout);
            _dotting = true;
        }
        else if (!tracker().testFailed())
        {
            (*_o) << ".";
            _o->flush();
            fflush(stdout);
            _dotting = true;
        }
    }

    void leaveWorld(const WorldDescription &desc)
    {
        if (!tracker().failedTests())
        {
            (*_o) << "OK!" << endl;
            return;
        }
        newLine();
        (*_o) << "Failed " << tracker().failedTests() << " and Skipped " << tracker().skippedTests() << " of " << totalTests << endl;
        unsigned numPassed = desc.numTotalTests() - tracker().failedTests() - tracker().skippedTests();
        unsigned numTotal = desc.numTotalTests() - tracker().skippedTests();
        if (numTotal == 0)
        {
            (*_o) << "Success rate: 100%" << endl;
        }
        else
        {
            (*_o) << "Success rate: " << (unsigned)(numPassed * 100.0 / numTotal) << "%" << endl;
        }
    }

    void trace(const char *file, int line, const char *expression)
    {
        stop(file, line) << "Trace: " << (expression ? expression : "") << endl;
    }

    void warning(const char *file, int line, const char *expression)
    {
        stop(file, line) << _warningString << ": " <<
                         (expression ? expression : "") << endl;
    }

    void skippedTest(const char *file, int line, const char *expression)
    {
        stop(file, line) << _warningString << ": Test skipped: " <<
                         (expression ? expression : "") << endl;
    }

    void failedTest(const char *file, int line, const char *expression)
    {
        stop(file, line) << _errorString << ": Test failed: " <<
                         (expression ? expression : "") << endl;
    }

    void failedAssert(const char *file, int line, const char *expression)
    {
        stop(file, line) << _errorString << ": Assertion failed: " <<
                         (expression ? expression : "") << endl;
    }

    void failedAssertEquals(const char *file, int line,
                            const char *xStr, const char *yStr,
                            const char *x, const char *y)
    {
        stop(file, line) << _errorString << ": Expected (" <<
                         xStr << " == " << yStr << "), found (" <<
                         x << " != " << y << ")" << endl;
    }

    void failedAssertSameData(const char *file, int line,
                              const char *xStr, const char *yStr,
                              const char *sizeStr, const void *x,
                              const void *y, unsigned size)
    {
        stop(file, line) << _errorString << ": Expected " << sizeStr << " (" << size << ") bytes to be equal at (" <<
                         xStr << ") and (" << yStr << "), found:" << endl;
        dump(x, size);
        (*_o) << "     differs from" << endl;
        dump(y, size);
    }

    void failedAssertSameFiles(const char* file, int line,
                               const char*, const char*,
                               const char* explanation
                              )
    {
        stop(file, line) << _errorString << ": " <<
                         (explanation ? explanation : "") << endl;
    }

    void failedAssertDelta(const char *file, int line,
                           const char *xStr, const char *yStr, const char *dStr,
                           const char *x, const char *y, const char *d)
    {
        stop(file, line) << _errorString << ": Expected (" <<
                         xStr << " == " << yStr << ") up to " << dStr << " (" << d << "), found (" <<
                         x << " != " << y << ")" << endl;
    }

    void failedAssertDiffers(const char *file, int line,
                             const char *xStr, const char *yStr,
                             const char *value)
    {
        stop(file, line) << _errorString << ": Expected (" <<
                         xStr << " != " << yStr << "), found (" <<
                         value << ")" << endl;
    }

    void failedAssertLessThan(const char *file, int line,
                              const char *xStr, const char *yStr,
                              const char *x, const char *y)
    {
        stop(file, line) << _errorString << ": Expected (" <<
                         xStr << " < " << yStr << "), found (" <<
                         x << " >= " << y << ")" << endl;
    }

    void failedAssertLessThanEquals(const char *file, int line,
                                    const char *xStr, const char *yStr,
                                    const char *x, const char *y)
    {
        stop(file, line) << _errorString << ": Expected (" <<
                         xStr << " <= " << yStr << "), found (" <<
                         x << " > " << y << ")" << endl;
    }

    void failedAssertRelation(const char *file, int line,
                              const char *relation, const char *xStr, const char *yStr,
                              const char *x, const char *y)
    {
        stop(file, line) << _errorString << ": Expected " << relation << "( " <<
                         xStr << ", " << yStr << " ), found !" << relation << "( " << x << ", " << y << " )" << endl;
    }

    void failedAssertPredicate(const char *file, int line,
                               const char *predicate, const char *xStr, const char *x)
    {
        stop(file, line) << _errorString << ": Expected " << predicate << "( " <<
                         xStr << " ), found !" << predicate << "( " << x << " )" << endl;
    }

    void failedAssertThrows(const char *file, int line,
                            const char *expression, const char *type,
                            bool otherThrown)
    {
        stop(file, line) << _errorString << ": Expected (" << expression << ") to throw (" <<
                         type << ") but it " << (otherThrown ? "threw something else" : "didn't throw") <<
                         endl;
    }

    void failedAssertThrowsNot(const char *file, int line, const char *expression)
    {
        stop(file, line) << _errorString << ": Expected (" << expression << ") not to throw, but it did" <<
                         endl;
    }

protected:
    OutputStream *outputStream() const
    {
        return _o;
    }

private:
    ErrorFormatter(const ErrorFormatter &);
    ErrorFormatter &operator=(const ErrorFormatter &);

    OutputStream &stop(const char *file, int line)
    {
        newLine();
        reportTest();
        return (*_o) << file << _preLine << line << _postLine << ": ";
    }

    void newLine(void)
    {
        if (_dotting)
        {
            (*_o) << endl;
            _dotting = false;
        }
    }

    void reportTest(void)
    {
        if (_reported)
        {
            return;
        }
        (*_o) << "In " << tracker().suite().suiteName() << "::" << tracker().test().testName() << ":" << endl;
        _reported = true;
    }

    void dump(const void *buffer, unsigned size)
    {
        if (!buffer)
        {
            dumpNull();
        }
        else
        {
            dumpBuffer(buffer, size);
        }
    }

    void dumpNull()
    {
        (*_o) << "   (null)" << endl;
    }

    void dumpBuffer(const void *buffer, unsigned size)
    {
        unsigned dumpSize = size;
        if (maxDumpSize() && dumpSize > maxDumpSize())
        {
            dumpSize = maxDumpSize();
        }

        const unsigned char *p = (const unsigned char *)buffer;
        (*_o) << "   { ";
        for (unsigned i = 0; i < dumpSize; ++ i)
        {
            (*_o) << byteToHex(*p++) << " ";
        }
        if (dumpSize < size)
        {
            (*_o) << "... ";
        }
        (*_o) << "}" << endl;
    }

    static void endl(OutputStream &o)
    {
        OutputStream::endl(o);
    }

    bool _dotting;
    bool _reported;
    OutputStream *_o;
    const char *_preLine;
    const char *_postLine;
    const char *_errorString;
    const char *_warningString;
};
}

#endif // __cxxtest__ErrorFormatter_h__

